fix: clarify "Replace" in I-D submission form #8205
Conversation
Update help text In the "Replacement Information" section of the "Status" tab
Clarify "Replace" in I-D submission form
ghwood
changed the title
ietf/submit/forms.py
Outdated
| @@ -502,7 +502,7 @@ def clean_name(self): | |||
| return name | |||
|
|
|||
| class ReplacesForm(forms.Form): | |||
| replaces = SearchableDocumentsField(required=False, help_text="Any Internet-Drafts that this document replaces (approval required for replacing an Internet-Draft you are not the author of)") | |||
| replaces = SearchableDocumentsField(required=False, help_text="An I-D submission will be automatically attached to the previous version of the I-D with the same name, or assigned "-00" version if no previous version exists. If this submission is intended to replace an I-D with a different name (e.g. when an individual I-D is adopted as a Working Group document), please enter that name here. (Approval required to replace an I-D for which you are not an author.)") | |||
There was a problem hiding this comment.
There's a syntax error here because of the "-00" inside the quoted string. You can change the outer quotes to ' to fix this.
* chore: update dependencies * fix: eslint + neostandard * fix: add corepack prompt env var to init script * docs: Update README.md --------- Co-authored-by: Robert Sparks <[email protected]>
update quote syntax issue on previous update help text In the "Replacement Information" section of the "Status" tab to fix ietf-tools#8059
fix: clarify "Replace" in I-D submission form ietf-tools#8205
|
Thanks for pushing on this. Some thoughts below:
The first sentence doesn't work for me - it sees to imply "-00" is a thing that happens at this point, but -00 was chosen by the submitter long before the submitter gets to this form. I also don't think "automatically attached to a previous" is what happens, or is the right model of what's happening for other people to build. Instead, we need to reinforce that there are versions of an Internet-Draft, and that an Internet-Draft might get replaced with some other Internet-Draft(s). Maybe imperative statements rather than explanation would work better? My alternate suggestion: Do not enter anything here if you are only submitting the next version of your Internet-Draft. Only enter items here if this submission is intended to replace an I-D with a different name. A typical use of this field is to note what individual I-Ds are replaced by a new -00 Working group I-D. Note that additional approval will be required to replace an I-D for which you are not an author. |
|
mph - just spotted that you're merging back into your fork's main. That will be painful for you in the long run. I'll followup with you on it offline. For anyone else that may stumble across this - it's better to leave main in your fork alone - sync it with ietf-tools/main periodically. Build your PRs in another branch. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8205 +/- ##
==========================================
+ Coverage 88.78% 88.93% +0.15%
==========================================
Files 296 303 +7
Lines 41320 41260 -60
==========================================
+ Hits 36687 36696 +9
+ Misses 4633 4564 -69 ☔ View full report in Codecov by Sentry. |
Update help text In the "Replacement Information" section of the "Status" tab to fix #8059